<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>transwarp: transwarp::releaser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">transwarp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacetranswarp.html">transwarp</a></li><li class="navelem"><a class="el" href="classtranswarp_1_1releaser.html">releaser</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classtranswarp_1_1releaser-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">transwarp::releaser Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The releaser will release a task's future when the task's <code>after_satisfied</code> event was received which happens when all children received the task's result. The releaser should be used in cases where the task's result is only needed for consumption by its children and can then be discarded.  
 <a href="classtranswarp_1_1releaser.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="transwarp_8h_source.html">transwarp.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for transwarp::releaser:</div>
<div class="dyncontent">
<div class="center"><img src="classtranswarp_1_1releaser__inherit__graph.png" border="0" usemap="#transwarp_1_1releaser_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for transwarp::releaser:</div>
<div class="dyncontent">
<div class="center"><img src="classtranswarp_1_1releaser__coll__graph.png" border="0" usemap="#transwarp_1_1releaser_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abf69985d4b6dd365599f3a32d273002e"><td class="memItemLeft" align="right" valign="top"><a id="abf69985d4b6dd365599f3a32d273002e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtranswarp_1_1releaser.html#abf69985d4b6dd365599f3a32d273002e">releaser</a> (std::shared_ptr&lt; <a class="el" href="classtranswarp_1_1executor.html">transwarp::executor</a> &gt; <a class="el" href="classtranswarp_1_1executor.html">executor</a>)</td></tr>
<tr class="memdesc:abf69985d4b6dd365599f3a32d273002e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The executor gives control over where a task's future is released. <br /></td></tr>
<tr class="separator:abf69985d4b6dd365599f3a32d273002e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2334a94096617d9de01eb2ddd85e185"><td class="memItemLeft" align="right" valign="top"><a id="ad2334a94096617d9de01eb2ddd85e185"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>releaser</b> (const <a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;)=delete</td></tr>
<tr class="separator:ad2334a94096617d9de01eb2ddd85e185"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1351b0d7e093a081942bb988c8cb907f"><td class="memItemLeft" align="right" valign="top"><a id="a1351b0d7e093a081942bb988c8cb907f"></a>
<a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;)=delete</td></tr>
<tr class="separator:a1351b0d7e093a081942bb988c8cb907f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a623bebfe6afa0adb43b361e026a13f5b"><td class="memItemLeft" align="right" valign="top"><a id="a623bebfe6afa0adb43b361e026a13f5b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>releaser</b> (<a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a623bebfe6afa0adb43b361e026a13f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e384e599e04ad6339a71c27e1c3d020"><td class="memItemLeft" align="right" valign="top"><a id="a4e384e599e04ad6339a71c27e1c3d020"></a>
<a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classtranswarp_1_1releaser.html">releaser</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a4e384e599e04ad6339a71c27e1c3d020"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4967872e7536cb4a8dfa406d642d26e"><td class="memItemLeft" align="right" valign="top"><a id="ac4967872e7536cb4a8dfa406d642d26e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtranswarp_1_1releaser.html#ac4967872e7536cb4a8dfa406d642d26e">handle_event</a> (const <a class="el" href="namespacetranswarp.html#a857009a6efbb2f34495ee81664a376dc">transwarp::event_type</a> event, <a class="el" href="classtranswarp_1_1itask.html">transwarp::itask</a> &amp;<a class="el" href="classtranswarp_1_1task.html">task</a>) override</td></tr>
<tr class="memdesc:ac4967872e7536cb4a8dfa406d642d26e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This may be called from arbitrary threads depending on the event type (see <a class="el" href="namespacetranswarp.html#a857009a6efbb2f34495ee81664a376dc" title="The task events that can be subscribed to using the listener interface.">transwarp::event_type</a>). The implementer needs to ensure that this never throws exceptions. <br /></td></tr>
<tr class="separator:ac4967872e7536cb4a8dfa406d642d26e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The releaser will release a task's future when the task's <code>after_satisfied</code> event was received which happens when all children received the task's result. The releaser should be used in cases where the task's result is only needed for consumption by its children and can then be discarded. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/<a class="el" href="transwarp_8h_source.html">transwarp.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
